FreeHandWaveCommand Constructor(int[],int,int,int,RasterColor,FreeHandWaveCommandFlags)

Summary

Initializes a new FreeHandWaveCommand class object with explicit parameters.

Syntax

C++/CLI

Python

public FreeHandWaveCommand( 
   int[] amplitudes, 
   int scale, 
   int waveLength, 
   int angle, 
   RasterColor fillColor, 
   FreeHandWaveCommandFlags flags 
)

public: 
FreeHandWaveCommand(  
   array<int>^ amplitudes, 
   int scale, 
   int waveLength, 
   int angle, 
   RasterColor fillColor, 
   FreeHandWaveCommandFlags flags 
)

__init__(self,amplitudes,scale,waveLength,angle,fillColor,flags) # Overloaded constructor

Parameters

amplitudes
Array of integers that represent wave values. The real value of the array elements is divided by 1000. These values are generally obtained from the Leadtools.ImageProcessing.Effects.EffectsUtilities.GetCurvePoints(System.Int32[],Leadtools.LeadPoint[],Leadtools.ImageProcessing.Effects.CurvePointsType) utility method.

scale
Factor used to increase or decrease the various amplitude values in the amplitudes array. Each value in the amplitudes array is multiplied by this factor. The real factor value is the Scale value divided by 100. This property only accepts positive values.

waveLength
Value that represents the wave length, if FreeHandWaveCommandFlags.Period flag is set. Possible values range from 1 - 100 and give the wavelength as a percentage of the image dimensions. If FreeHandWaveCommandFlags.Frequency flag is set, this value is the number of repeated waves.

angle
Wave rotation angle in hundredths of a degree (+/-). The valid range is from -36000 to 36000. The value in degrees is angle divided by 100.

fillColor
RasterColor object that specifies the fill color for any exposed areas.

flags
FreeHandWaveCommandFlags enumeration that indicate how to handle exposed areas, and the type of information contained in waveLength parameter.

Example

Run the FreeHandWaveCommand on an image and apply triangular wave on the loaded image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
using Leadtools.ImageProcessing.Effects; 
 
 
public void FreeHandWaveConstructorExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample5.cmp")); 
 
   // Prepare the command 
   LeadPoint[] userPoint = new LeadPoint[4]; 
   // Fill UserPoint array with points that define a triangular wave 
   userPoint[0].X = 0; 
   userPoint[0].Y = 0; 
   userPoint[1].X = 3; 
   userPoint[1].Y = 10; 
   userPoint[2].X = 9; 
   userPoint[2].Y = -10; 
   userPoint[3].X = 12; 
   userPoint[3].Y = 0; 
 
   int[] amplitudes = new int[13]; 
   //Draw a triangular wave according to UserPoint points and store the Amplitudes values in the Amplitudes array. 
   EffectsUtilities.GetCurvePoints(amplitudes, userPoint, CurvePointsType.Linear); 
 
   FreeHandWaveCommand command = new FreeHandWaveCommand(amplitudes, 100, 10, 0, new RasterColor(0, 0, 0), FreeHandWaveCommandFlags.Repeat | FreeHandWaveCommandFlags.Frequency); 
   command.Run(image); 
   codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24); 
 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}

Requirements

Target Platforms

Reference

FreeHandWaveCommand Class

FreeHandWaveCommand Members

Overload List

Download our FREE evaluation

Help Version 22.0.2023.3.31